home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 48 / Amiga Format CD48 (1999-12-13)(Future Publishing)(GB)(Track 1 of 2)[!][issue 2000-01].iso / -serious- / programming / mui / mcc_transferanim / docs / english / transferanim_mcc.doc next >
Text File  |  1999-11-01  |  3KB  |  122 lines
  1.  
  2.         TransferAnim.mcc documentation
  3.  
  4. TransferAnim.mcc is a MUI customclass intended to display transfer
  5. (or busy) animations as known from browsers. 
  6.  
  7. This release also has very limited documentation.
  8. Developers will get most out of reading the autodocs and included
  9. example.
  10.  
  11. MUI is copyright Stefan Stuntz.
  12. Thanks to Allan Odgaard for putting up with my questions.
  13. Thanks to Kai Hofmann for the installerscript and suggestions.
  14. The icons are taken from MUI's main archive.
  15.  
  16.  
  17.   Why
  18.  
  19. Having a few different ongoing projects, I realized that it was a
  20. specific piece of code I reused in almost all of them (the mui ones, 
  21. anyway).
  22. And this was the code to display datatypesobjects and transferanimations.
  23. So I decided to make this a customclass for easier integration in
  24. my own programs and to allow others to easily implement similar
  25. objects in their projects, without too much effort.
  26.  
  27.  
  28.   Requirements
  29.  
  30. This first release of TransferAnim.mcc uses datatypes to load
  31. images and it also uses some other 39+ graphics calls, thus it
  32. will only work on 3.x+ machines.
  33.  
  34.  
  35.   Installation
  36.  
  37. Thanx to Kai Hofmann, the customclass comes with an installerscript,
  38. without his work on MCC-Install, this would not be true.
  39.  
  40. So, for easy installation, just doubleclick the install icon and en-
  41. joy yourself as you loose some hd space. 
  42. The images needs not to be installed, they are only there for the
  43. supplied demo.
  44. However, if you don't install the images, the demo will look pretty
  45. lousy unless you run it directly from the unarchived directory.
  46.  
  47. If you wish to install the class manually for some reason, just copy
  48.  
  49.     libs/mui/#? to mui:libs/mui/
  50.     images/#? to mui:images/
  51.     demos/#? to mui:demos/
  52.  
  53. and if you wish to use the developerfiles, just copy them from
  54. developers/ to your prefered autodoc and includes directories.
  55.  
  56.  
  57.    Todo
  58.  
  59. The class has the basic features I require for my own programs,
  60. but if you have requests for me to implement other functions,
  61. please suggest these to me!
  62.  
  63.   
  64.     Author
  65.  
  66. The class is written by Linus McCabe with help from alot of people on
  67. the mui mailinglist.
  68.  
  69. To get in touch with me write to
  70.  
  71. Linus McCabe
  72. Rogsholmsv 6
  73. 51532 Viskafors
  74.  
  75. sparkle@hehe.com
  76. http://sparkle.amiga.tm
  77.  
  78. I'm open to suggestions, bugreports and critisism!
  79.  
  80.  
  81.   Disclaimer
  82.  
  83. The author takes no responsibility whatsoever to any loss of data
  84.  or other damage this class might cause.
  85.  
  86. Use it at your won risk!
  87.  
  88.  
  89.   Usage
  90.  
  91. The only things the enduser needs to worry about is installing the
  92. class correctly and the mui prefs.
  93.  
  94. If you wish, you can change the mui prefs to your preffered settings.
  95.  
  96. Currently there are two options to change.
  97.  
  98.     ° Default animation
  99.         This animation is used whenever the animation specified by
  100.         the program was not loadable for some reaso, maybe  because
  101.         the file was not found.
  102.  
  103.     ° Default precision.
  104.         Here you can specify with what precision you want the ani-
  105.         mations remapped.
  106.  
  107.     ° Play mode
  108.         Specify how you want the animations to play, choices are
  109.         play always, play when window's active or never play.
  110.  
  111.  
  112.    Developers
  113.  
  114. Developers who wish to use my class in their programs are totally free
  115. to do so. However, I'd wish to be notified about it, and I wouldnt mind
  116. a free copy of your program if you are charging money for it. This is not 
  117. mandatory, however.
  118.  
  119. I also wouldnt mind being mentioned in the about requester or the docu-
  120. mentation for the program.
  121.  
  122.